home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 3 / Cream of the Crop 3.iso / clipper / ks94an.zip / HILIGHT.HDR < prev    next >
Text File  |  1994-04-25  |  2KB  |  52 lines

  1. /******************************************************************************
  2.                  The Klipper Library, for CA-Clipper 5.x
  3.         Copyright (c), 1994, Wallace Information Systems Engineering
  4.  
  5. FUNCTION:
  6.  
  7. _Hilight( nLine, cText, cColor ) --> NI
  8.  
  9. PARAMETERS:
  10.  
  11. nLine   : Line to Highlight on
  12. cText   : text on nLine to highlight
  13. cColor  : color to highlight with
  14.  
  15. SHORT:
  16.  
  17. Highlight text wherever it appears on a screen or screen line.
  18.  
  19. DESCRIPTION:
  20.  
  21. _HighLight() reads the screen at the line specified in nLine and looks for
  22. the text passed in cText.  If found, it is rewritten on the screen in
  23. the color specified in cColor.
  24.  
  25. if nLine is not specified, then the function looks for and highlights the
  26. text wherever it occurs on the entire screen.
  27.  
  28. NOTE:
  29.  
  30.  
  31.  
  32. EXAMPLE:
  33.  
  34. @ 10,10 say 'Dear John,'
  35. @ 12,10 say "I'm so sorry to have to tell you this..."
  36.  
  37. _HighLight(10,'John','w+/n')
  38. _HighLight(,'John','w+/n')
  39.  
  40. Result: Both of these calls will do the same thing.
  41.  
  42. The first call specifies that the text is on line 10.
  43.  
  44. The second format can be used when the text has scrolled or moved, or when
  45. you just forgot where you put it, or when you are feeling plain lazy and
  46. do not want to figure which line it is on.  The text "John" will
  47. be highlighted wherever it occurs on the screen and as many times as
  48. it occurs. (Specifying the line will cause only those occurances on that
  49. line to be highlighted).
  50.  
  51. ******************************************************************************/
  52.